﻿/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Sys.Workflow.Engine.Management
{
    /// <summary>
    /// Allows programmatic querying of <seealso cref="TablePage"/>s.
    /// 
    /// 
    /// </summary>
    public interface ITablePageQuery
    {

        /// <summary>
        /// The name of the table of which a page must be fetched.
        /// </summary>
        ITablePageQuery SetTableName(string tableName);

        /// <summary>
        /// Orders the resulting table page rows by the given column in ascending order.
        /// </summary>
        ITablePageQuery OrderAsc(string column);

        /// <summary>
        /// Orders the resulting table page rows by the given column in descending order.
        /// </summary>
        ITablePageQuery OrderDesc(string column);

        /// <summary>
        /// Executes the query and returns the <seealso cref="TablePage"/>.
        /// </summary>
        TablePage ListPage(int firstResult, int maxResults);
    }

}